doc: final README streamlining [doc: 6/6] #1294
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
phip1611
changed the title
2 tasks
phip1611
changed the title
nicholasbishop
approved these changes
Aug 24, 2024
README.md
Outdated
| Logger and an Allocator. | ||
| This is the **main contribution** of this project. | ||
| - [`uefi-macros`](/uefi-macros/README.md): Helper macros used by `uefi`. | ||
| - [`uefi-test-runner`](/uefi-test-runner/README.md): a UEFI application that runs our unit / integration tests. | ||
|
|
||
| - `uefi-raw`: raw types that closely match the definitions in the UEFI |
There was a problem hiding this comment.
Duplicate entry, uefi-raw is now linked/described at the top of the list.
There was a problem hiding this comment.
Sorry, an artifact of all the major rebases this PR experienced over the last weeks. Fixed!
Now, the README are the entry into the repository and guide the user to the actual documentation in lib.rs respectively on docs.rs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is split-out 6/6 from #1264 to improve reviewability.
This adds to uefi/README how our documentation is organized.
Steps to Un-draft
Checklist